Broadband Availability API
Rate Limiting
All requests sent from a specific API consumer to the Broadband Availability API may be subject to a rate limit.
Rate limiting restricts the number of requests which the API accepts for processing over a given period of time (time window). If the number of requests exceeds the rate limit, then subsequent requests are rejected.
If rate limiting is applied to your requests, responses will contain the following headers that provide more information regarding the rate limit status:
| Header | Description | Example |
|---|---|---|
| X-Ratelimit-Limit | The total number of requests allowed during the time window. | 100 - Rate limit of 100 requests |
| X-Ratelimit-Remaining | The number of requests that can still be submitted during the time window. | 66 - Another 66 requests can be submitted before they are rejected |
| X-Ratelimit-Reset | The time window, within which requests are counted for determining the rate limit (milliseconds). | 60000 - Time window of 1 Minute, the time bound applied to the rate limiting |
| System Rate Limiting | A system level rate limit of 5 transactions per second shall be implemented. Note: This applies to both production and sandbox. | 5 transactions per second |
| Client Key Rate Limiting | A per client key rate limit of 10,000 transactions per day shall be implemented. Notes: -Applies to both production and sandbox. - Will be implemented within one rate limiting tier. | 10,000 transactions per day |